home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / zstein.z / zstein
Encoding:
Text File  |  2002-10-03  |  6.1 KB  |  199 lines
  1.  
  2.  
  3.  
  4. ZZZZSSSSTTTTEEEEIIIINNNN((((3333SSSS))))                                                          ZZZZSSSSTTTTEEEEIIIINNNN((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ZSTEIN - compute the eigenvectors of a real symmetric tridiagonal matrix
  10.      T corresponding to specified eigenvalues, using inverse iteration
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE ZSTEIN( N, D, E, M, W, IBLOCK, ISPLIT, Z, LDZ, WORK, IWORK,
  14.                         IFAIL, INFO )
  15.  
  16.          INTEGER        INFO, LDZ, M, N
  17.  
  18.          INTEGER        IBLOCK( * ), IFAIL( * ), ISPLIT( * ), IWORK( * )
  19.  
  20.          DOUBLE         PRECISION D( * ), E( * ), W( * ), WORK( * )
  21.  
  22.          COMPLEX*16     Z( LDZ, * )
  23.  
  24. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  25.      These routines are part of the SCSL Scientific Library and can be loaded
  26.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  27.      directs the linker to use the multi-processor version of the library.
  28.  
  29.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  30.      4 bytes (32 bits). Another version of SCSL is available in which integers
  31.      are 8 bytes (64 bits).  This version allows the user access to larger
  32.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  33.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  34.      only one of the two versions; 4-byte integer and 8-byte integer library
  35.      calls cannot be mixed.
  36.  
  37. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  38.      ZSTEIN computes the eigenvectors of a real symmetric tridiagonal matrix T
  39.      corresponding to specified eigenvalues, using inverse iteration. The
  40.      maximum number of iterations allowed for each eigenvector is specified by
  41.      an internal parameter MAXITS (currently set to 5).
  42.  
  43.      Although the eigenvectors are real, they are stored in a complex array,
  44.      which may be passed to ZUNMTR or ZUPMTR for back
  45.      transformation to the eigenvectors of a complex Hermitian matrix which
  46.      was reduced to tridiagonal form.
  47.  
  48.  
  49.  
  50. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  51.      N       (input) INTEGER
  52.              The order of the matrix.  N >= 0.
  53.  
  54.      D       (input) DOUBLE PRECISION array, dimension (N)
  55.              The n diagonal elements of the tridiagonal matrix T.
  56.  
  57.      E       (input) DOUBLE PRECISION array, dimension (N)
  58.              The (n-1) subdiagonal elements of the tridiagonal matrix T,
  59.              stored in elements 1 to N-1; E(N) need not be set.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ZZZZSSSSTTTTEEEEIIIINNNN((((3333SSSS))))                                                          ZZZZSSSSTTTTEEEEIIIINNNN((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      M       (input) INTEGER
  75.              The number of eigenvectors to be found.  0 <= M <= N.
  76.  
  77.      W       (input) DOUBLE PRECISION array, dimension (N)
  78.              The first M elements of W contain the eigenvalues for which
  79.              eigenvectors are to be computed.  The eigenvalues should be
  80.              grouped by split-off block and ordered from smallest to largest
  81.              within the block.  ( The output array W from DSTEBZ with ORDER =
  82.              'B' is expected here. )
  83.  
  84.      IBLOCK  (input) INTEGER array, dimension (N)
  85.              The submatrix indices associated with the corresponding
  86.              eigenvalues in W; IBLOCK(i)=1 if eigenvalue W(i) belongs to the
  87.              first submatrix from the top, =2 if W(i) belongs to the second
  88.              submatrix, etc.  ( The output array IBLOCK from DSTEBZ is
  89.              expected here. )
  90.  
  91.      ISPLIT  (input) INTEGER array, dimension (N)
  92.              The splitting points, at which T breaks up into submatrices.  The
  93.              first submatrix consists of rows/columns 1 to ISPLIT( 1 ), the
  94.              second of rows/columns ISPLIT( 1 )+1 through ISPLIT( 2 ), etc.  (
  95.              The output array ISPLIT from DSTEBZ is expected here. )
  96.  
  97.      Z       (output) COMPLEX*16 array, dimension (LDZ, M)
  98.              The computed eigenvectors.  The eigenvector associated with the
  99.              eigenvalue W(i) is stored in the i-th column of Z.  Any vector
  100.              which fails to converge is set to its current iterate after
  101.              MAXITS iterations.  The imaginary parts of the eigenvectors are
  102.              set to zero.
  103.  
  104.      LDZ     (input) INTEGER
  105.              The leading dimension of the array Z.  LDZ >= max(1,N).
  106.  
  107.      WORK    (workspace) DOUBLE PRECISION array, dimension (5*N)
  108.  
  109.      IWORK   (workspace) INTEGER array, dimension (N)
  110.  
  111.      IFAIL   (output) INTEGER array, dimension (M)
  112.              On normal exit, all elements of IFAIL are zero.  If one or more
  113.              eigenvectors fail to converge after MAXITS iterations, then their
  114.              indices are stored in array IFAIL.
  115.  
  116.      INFO    (output) INTEGER
  117.              = 0: successful exit
  118.              < 0: if INFO = -i, the i-th argument had an illegal value
  119.              > 0: if INFO = i, then i eigenvectors failed to converge in
  120.              MAXITS iterations.  Their indices are stored in array IFAIL.
  121.  
  122. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  123.      MAXITS  INTEGER, default = 5
  124.              The maximum number of iterations performed.
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. ZZZZSSSSTTTTEEEEIIIINNNN((((3333SSSS))))                                                          ZZZZSSSSTTTTEEEEIIIINNNN((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      EXTRA   INTEGER, default = 2
  141.              The number of iterations performed after norm growth criterion is
  142.              satisfied, should be at least 1.
  143.  
  144. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  145.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  146.  
  147.      This man page is available only online.
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.